Skip to content

Accessibility best practices#3641

Merged
ahpook merged 12 commits intogithub:mainfrom
mlama007:accessibility-best-practices
Apr 29, 2026
Merged

Accessibility best practices#3641
ahpook merged 12 commits intogithub:mainfrom
mlama007:accessibility-best-practices

Conversation

@mlama007
Copy link
Copy Markdown
Contributor

@mlama007 mlama007 commented Apr 24, 2026

  • Have you followed the contributing guidelines?
  • Have you explained what your changes do, and why they add value to the Guides?

Please note: we will close your PR without comment if you do not check the boxes above and provide ALL requested information.


The accessibility team would love to create a new guide for accessibility best practices. We believe an accessibility guide would fill an information gap and become a valuable resource for open source maintainers.

Copilot AI review requested due to automatic review settings April 24, 2026 18:30
@mlama007 mlama007 requested a review from a team as a code owner April 24, 2026 18:30
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Adds a new guide article describing accessibility best practices for open source projects, with practical recommendations spanning documentation, UI design, tooling, contribution workflows, and ongoing testing.

Changes:

  • Introduces a new long-form accessibility best practices article under _articles/.
  • Covers guidance on accessibility statements, accessible docs, accessible UI patterns, accessible tooling (CLI/logs), contribution workflows, and testing approaches.
Show a summary per file
File Description
_articles/accessibility-best-practices-for-your-project.md New accessibility best-practices guide content and metadata for publication

Copilot's findings

Tip

Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

  • Files reviewed: 1/1 changed files
  • Comments generated: 6

Comment thread _articles/accessibility-best-practices-for-your-project.md Outdated
Comment thread _articles/accessibility-best-practices-for-your-project.md Outdated
Comment thread _articles/accessibility-best-practices-for-your-project.md Outdated
Comment thread _articles/accessibility-best-practices-for-your-project.md Outdated
Comment thread _articles/accessibility-best-practices-for-your-project.md
Comment thread _articles/accessibility-best-practices-for-your-project.md
Comment thread _articles/accessibility-best-practices-for-your-project.md Outdated
Copy link
Copy Markdown
Contributor

@ahpook ahpook left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Left a couple of comments on the copilot suggestions and made a couple more but overall this looks great, thanks for the contribution!

@ahpook
Copy link
Copy Markdown
Contributor

ahpook commented Apr 24, 2026

Also checkout the test failures - most of these should be automatically fixable, it looks like the main culprits are "smart quotes" instead of straight ASCII, bullet points being *, and emphasis markers using _word_ not *word*.
https://github.com/github/opensource.guide/actions/runs/24913668441/job/72960934715?pr=3641

@mlama007 mlama007 requested a review from ahpook April 29, 2026 20:32
Copy link
Copy Markdown
Contributor

@ahpook ahpook left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks great, thanks!

@ahpook ahpook temporarily deployed to Pages Preview April 29, 2026 21:50 — with GitHub Actions Inactive
@ahpook ahpook added this pull request to the merge queue Apr 29, 2026
Merged via the queue into github:main with commit 97b6e90 Apr 29, 2026
7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants